Skip to content

Adding docstrings#134

Open
immasushiroll wants to merge 5 commits into
PoonLab:devfrom
immasushiroll:adding_docstrings
Open

Adding docstrings#134
immasushiroll wants to merge 5 commits into
PoonLab:devfrom
immasushiroll:adding_docstrings

Conversation

@immasushiroll

Copy link
Copy Markdown

Hello! First time contributing, sorry it took so long, I figured these changes aren't that important as they're all comments.

This is a first draft and a low impact PR, so feel free to point out if I my descriptions don't accurately reflect the functional logic, thank you so much for your time and help!

You may see some of the .csv files have changed or have been added. Those were generated from running updater.py, which pulls the latest updates from the APOBEC DRMS database. Basically, I updated the .csv files to a more recent version, I can remove those changes if it's preferred for a cleaner PR.

When I go to test run sierralocal with these changes (specifically the new .csv files) I get the following where it considers it an "unusual file". Would be great if someone could take a look at this just in case, not sure if this behaviour is expected. Test run w/ added docstring changes:

l(.venv) [immasushiroll@kallisto sierra-local]$ sierralocal RT.fa
searching path /home/immasushiroll/Windows/Users/jane8/repos/sierra-local/.venv/lib/python3.14/site-packages/sierralocal/data/HIVDB*.xml
searching path /home/immasushiroll/Windows/Users/jane8/repos/sierra-local/.venv/lib/python3.14/site-packages/sierralocal/data/apobec_drms.json
HIVdb version 9.4
Using unusual file: /home/immasushiroll/Windows/Users/jane8/repos/sierra-local/.venv/lib/python3.14/site-packages/sierralocal/data/rx-all_subtype-all.csv
Using SDRM mutations file: /home/immasushiroll/Windows/Users/jane8/repos/sierra-local/.venv/lib/python3.14/site-packages/sierralocal/data/sdrms_hiv1.csv
Using mutation type file: /home/immasushiroll/Windows/Users/jane8/repos/sierra-local/.venv/lib/python3.14/site-packages/sierralocal/data/mutation-type-pairs_hiv1.csv
Using APOBEC file: /home/immasushiroll/Windows/Users/jane8/repos/sierra-local/.venv/lib/python3.14/site-packages/sierralocal/data/apobecs.csv
Aligning using post-align
Aligned RT.fa
100 sequences found in file RT.fa.
Writing JSON to file RT_results.json
Time elapsed: 9.4609 seconds (10.682 it/s)

@ArtPoon

ArtPoon commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Thanks @immasushiroll - can you please remove the data/ files from your commit? We want to avoid overwriting those defaults. I know it's a pain to have them there.

@ArtPoon ArtPoon changed the base branch from master to dev June 27, 2026 16:39
@immasushiroll

Copy link
Copy Markdown
Author

@ArtPoon done! changes in data just completely removed, that should be easiest, did you also want to squash those commits?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants